home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / rtrim51.zip / RTRIM.DOC < prev    next >
Text File  |  1991-12-06  |  23KB  |  498 lines

  1.  
  2.                          RTRIM - VERSION 5.1
  3.  
  4.  
  5.                           Author - Bob Keber
  6.  
  7.                            336 Swain Blvd.
  8.                          Lake Worth, FL 33463
  9.                            (407) 969-3643
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                   Released To Public Domain - No Charge
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.                                DISCLAIMER
  34.  
  35.                     Use This Software At Your Own Risk
  36.  
  37.    The author of this software makes or offers no warranty, either
  38.    expressed or implied, regarding any of the software programs included
  39.    with this package. There is no warranty for this software's usefulness,
  40.    or for it's fitness for any particular purpose. The author will not be
  41.    liable for any damages arising from the use of (or from the inability
  42.    to use) this software. The author will not be liable for lost profits,
  43.    lost savings, lost income, lost time, claims by other parties, or for
  44.    other incidental or consequential damages arising from the use of (or
  45.    from the inability to use) this software. Use of this software is
  46.    entirely at the user's own risk.
  47.  
  48.                            GETTING STARTED
  49.  
  50.                             COMMAND FORMAT
  51.  
  52.    FOR  "QUICK" RTRIM OPERATION: Enter one of the  following  commands
  53. from any DOS or MS/DOS Screen Prompt......
  54.  
  55.  
  56. RTRIM                 (Runs RTRIM with full screen menus & help)
  57.  
  58.  
  59. RTRIM FileName.Ext    (Will Strip BLANKS from RIGHT END of text lines)
  60.  
  61. RTRIM FileName.Ext/H  (Trims RIGHT-BLANKS & Converts HI-BIT Characters)
  62.  
  63. RTRIM FileName.Ext/E  (Trims RIGHT-BLANKS & Removes "Escape Codes" such
  64.                        as FORM FEEDS & END OF PAGE)
  65.  
  66. RTRIM FileName.Ext/H/E   (BLANKS, ESCAPE CODES & HI-BIT Characters)
  67.  
  68.  
  69.     "FileName.Ext" represents the name of your TEXT file that you wish
  70. to  have  RTRIM.EXE  work  on. For instance,  if  you  wanted  to  use
  71. "RTRIM.DOC" as your input file, you would enter "RTRIM RTRIM.DOC".
  72.  
  73.     Unless  you specify another OUTPUT file name, the  DEFAULT  OUTPUT
  74. file name will be "OUTPUT.TXT". The output file will contain a copy of
  75. your original file, but with all of the changes you elected to perform
  76. upon it. Your original file will be left unchanged and exactly the way
  77. it  was to begin with.
  78.  
  79.     Always  check  over  your Output File VERY  carefully  BEFORE  you
  80. replace  your  Original  with it. Make sure  that  "Charts",  "Boxes",
  81. "Graphs", and so on, are as they should be, and that any "Page Offset"
  82. insertion or removal has not effected the text in a negative manner.
  83.  
  84.     If  your Input File has ANY GRAPHIC CHARACTERS which you  wish  to
  85. have  left alone (Boxes, Pictures, Drawings or Source Code  containing
  86. any  Command Line Graphics), DO NOT tell RTRIM to  convert  HIGH-BITS.
  87. RTRIM  will  happily convert ANY graphic character it  finds,  because
  88. Graphics are HIGH-BIT characters too. This would leave you with  Boxes
  89. shaped with M's, D's, and a host of other alphabet characters.
  90.  
  91.     FOR THE OTHER RTRIM OPTIONS: Enter the following command from  any
  92. DOS or MS/DOS Screen Prompt....
  93.  
  94.                  RTRIM            <...and hit Enter>
  95.  
  96.      RTRIM.EXE  will then load and proceed to guide you through all  of
  97. the various options with "on-screen" instructions and questions.
  98.  
  99.                          WHAT IS RTRIM.EXE ?
  100.  
  101.      It's  a  simple  little utility  for  "Adjusting"  and  "Changing"
  102. different kinds of "TEXT" files to suit YOUR OWN needs.
  103.  
  104.      RTRIM   will "Trim" all of the Spacebars, Nulls, and Blank  Spaces
  105. that  may   be  invisibly attached to the RIGHT end of  each  line  of
  106. text,   or which may be invisibly hiding on many of the "Blank"  lines
  107. within your text (also in any ASCII Source Code).
  108.  
  109.      This   feature will produce a copy of the original file which  (in
  110. many  cases) is much smaller than the the original file. And yet,   it
  111. does  this  without moving the original text's positions in the  file.
  112. There  are  NO  apparent, VISIBLE differences between  the  two  files
  113. except for the difference in sizes.
  114.  
  115.  
  116.                      ADDITIONAL "OPTIONAL" FEATURES
  117.  
  118.  OPTION  #1 - INSTALL PAGE OFFSET - Has the ability to create up  to  a
  119. nine  space "Left Margin" or  "Page  Offset"  in the new output  file.
  120. This   allows  you  to punch holes for the use of binders  and  report
  121. covers without covering up (or punching out) any of the text.
  122.  
  123.  
  124. OPTION  #2 - REMOVE PAGE OFFSET - Has the ability to "Remove" a  "Page
  125. Offset"  from any ASCII Text  file.  But be cautious, as this  routine
  126. will ask you  "How  many Spaces"  it should remove from the left  side
  127. (beginning)  of  each  line of  text.  If  you tell it to  remove  too
  128. many spaces  (more  than  any existing offset), it will quickly remove
  129. the  beginning characters from each  line of text too (in  the  output
  130. file only - originals are  never changed at all).
  131.  
  132.  
  133. OPTION   #3  -  REMOVE  EXCESSIVE BLANK LINES -  Has  the  ability  to
  134. "Remove" excessive "Blank  Lines" from any ASCII Text file.
  135.  
  136.     I'm   sure that many of us have had the misfortune  to  innocently
  137. begin  printing   someone's  "DOC"  file for some program,   only   to
  138. sit   and impatiently watch as our printer spits out page  after  page
  139. with  little  or  no text printed on them (eg:  "JOE'S  PROGRAM"   [65
  140. linespaces]..., "VERSION   1"   [65   linespaces]...,  "A    SHAREWARE
  141. PROGRAM"   [65 linespaces]...,  etc.). I swear, some of these  authors
  142. must own stock in a paper mill (or in a Garbage Dump).
  143.  
  144.     This  option eliminates this problem by removing  all   successive
  145. "Blank  Lines"  when  there are three (3) or more in a row.  It   will
  146. allow   a  maximum  of two (2) blank lines together,  and  then  start
  147. chopping  them out  of the text, thereby shortening the file (and  the
  148. paper  required to print it out).
  149.  
  150.  
  151. OPTION #4 - CONVERT HI-BIT WORDSTAR FILES - A feature that will  auto-
  152. matically  reset the "High Bits" on any character that has  the  "High 
  153. Bit" set.
  154.  
  155.     The  above  statement  may  sound  "very  scary,  technical   and
  156. complicated"  to   a  novice operator, so let me make  it  simpler  by
  157. explaining what this routine is most often used for.
  158.  
  159.     If you use a Word Processing program (like Wordstar for  example),
  160. you  may  find  that the text files look  something  like  an  "Arab's
  161. Alphabet"  if  you  try  to  read  (or print)  those   files   WITHOUT
  162. using the  Word Processor which created the files in the first place.
  163.  
  164.     This  kind  of  problem is especially tough if the  file  you  are
  165. trying  to read  or print originally came from someone else,  and  YOU
  166. DON'T   HAVE  their  brand of Word Processor (which  happens  on  many
  167. dowloaded  files).
  168.  
  169.     Those  kind of TEXT files will appear a bit scrambled because  the
  170. "High Bits" are set on the majority of the characters within the file.
  171. Why?  Who  Knows?  But we assume that the folks  who  wrote  the  Word
  172. Processing program (hopefully) had a good reason for doing things like
  173. this.
  174.  
  175.     All  that  RTRIM.EXE  does is "Reset" the "Bits"  back  to  normal
  176. again. It will NOT mess-around with any character who's bit is NOT set
  177. to high, so it's safe to run any ASCII Text (NO GRAPHICS) file through
  178. this routine. When RTRIM.EXE is done the copy of those files will then
  179. look (and print) much the way the Author originally intended them to.
  180.  
  181.  
  182. OPTION #5: "UN-JUSTIFY" A TEXT FILE -
  183.  
  184.     This  option  will  automatically remove all  those  "double"  and
  185. "triple"  spacebars  that many  word processors insert into  lines  of
  186. text to make each and every line the exact same length, and have every
  187. line end on the exact same column.
  188.  
  189.     Originally  (when printed from inside of the word  processor which
  190. created  them  -  with a printer capable of  printing  variable  sized
  191. spacebars),  those extra spacebars are divided evenly between all  the
  192. other  "normal" spacebars, each of which becomes slightly and  equally
  193. larger to "justify" the line without all those obvious extra spaces.
  194.  
  195.     However,  when  the same file is converted to  a  "plain  vanilla"
  196. ASCII  Text file, those extra spaces become "